package com.gitee.qdbp.general.common.api.settings.basic;

import java.util.List;
import com.gitee.qdbp.able.exception.ServiceException;
import com.gitee.qdbp.able.jdbc.ordering.OrderPaging;
import com.gitee.qdbp.able.jdbc.paging.PageList;
import com.gitee.qdbp.general.common.api.settings.model.AreaDivisionBean;
import com.gitee.qdbp.general.common.api.settings.model.AreaDivisionUpdate;
import com.gitee.qdbp.general.common.api.settings.model.AreaDivisionWhere;

public interface IAreaDivisionBasic {

    /**
     * 行政区划查询
     *
     * @param where 查询条件
     * @return 行政区划
     * @throws ServiceException 查询失败
     */
    AreaDivisionBean find(AreaDivisionWhere where) throws ServiceException;

    /**
     * 根据区域ID查询行政区划
     *
     * @param id 区域ID
     * @return 行政区划
     * @throws ServiceException 查询失败
     */
    AreaDivisionBean findById(String id) throws ServiceException;

    /**
     * 行政区划查询
     *
     * @param paging 排序分页条件
     * @return 行政区划列表
     * @throws ServiceException 查询失败
     */
    PageList<AreaDivisionBean> list(OrderPaging paging) throws ServiceException;

    /**
     * 行政区划查询
     *
     * @param where 查询条件
     * @param paging 排序分页条件
     * @return 行政区划列表
     * @throws ServiceException 查询失败
     */
    PageList<AreaDivisionBean> list(AreaDivisionWhere where, OrderPaging paging) throws ServiceException;

    /**
     * 根据区域ID查询行政区划列表
     *
     * @param ids 区域ID列表
     * @return 行政区划列表
     * @throws ServiceException 查询失败
     */
    PageList<AreaDivisionBean> listByIds(List<String> ids) throws ServiceException;

    /**
     * 创建行政区划
     *
     * @param model 待新增的行政区划
     * @return 受影响行数
     * @throws ServiceException 创建失败
     */
    int create(AreaDivisionBean model) throws ServiceException;

    /**
     * 批量创建行政区划
     *
     * @param models 待新增的行政区划
     * @return 受影响行数
     * @throws ServiceException 创建失败
     */
    int create(List<AreaDivisionBean> models) throws ServiceException;

    /**
     * 修改行政区划
     *
     * @param model 待修改的内容
     * @param errorOnUnaffected 受影响行数为0时是否抛异常
     * @return 受影响行数
     * @throws ServiceException 修改失败
     */
    int update(AreaDivisionUpdate model, boolean errorOnUnaffected) throws ServiceException;

    /**
     * 根据区域ID删除行政区划
     *
     * @param ids 待删除的行政区划的区域ID
     * @param errorOnRowsNotMatch 删除行数不匹配时是否抛异常
     * @return 删除行数
     * @throws ServiceException 删除失败
     */
    int deleteByIds(List<String> ids, boolean errorOnRowsNotMatch) throws ServiceException;

    /**
     * 根据条件删除行政区划
     *
     * @param where 条件
     * @param errorOnUnaffected 删除行数为0时是否抛异常
     * @return 删除行数
     * @throws ServiceException 删除失败
     */
    int delete(AreaDivisionWhere where, boolean errorOnUnaffected) throws ServiceException;

}
